
/*
 * Copyright (C) Igor Sysoev
 * Copyright (C) Nginx, Inc.
 */


#ifndef _NGX_EVENT_CONNECT_H_INCLUDED_
#define _NGX_EVENT_CONNECT_H_INCLUDED_


#include <ngx_config.h>
#include <ngx_core.h>
#include <ngx_event.h>


#define NGX_PEER_KEEPALIVE           1
#define NGX_PEER_NEXT                2
#define NGX_PEER_FAILED              4


typedef struct ngx_peer_connection_s  ngx_peer_connection_t;

typedef ngx_int_t (*ngx_event_get_peer_pt)(ngx_peer_connection_t *pc,
    void *data);
typedef void (*ngx_event_free_peer_pt)(ngx_peer_connection_t *pc, void *data,
    ngx_uint_t state);
#if (NGX_SSL)

typedef ngx_int_t (*ngx_event_set_peer_session_pt)(ngx_peer_connection_t *pc,
    void *data);
typedef void (*ngx_event_save_peer_session_pt)(ngx_peer_connection_t *pc,
    void *data);
#endif


struct ngx_peer_connection_s { //fzc: ngx_peer_connection_s是主动连接, 即nginx与上游peer的连接, ngx_peer_connection_s是以ngx_connection_s为基础的, 
    ngx_connection_t                *connection; //fzc: 复用ngx_connect_s中的字段

    struct sockaddr                 *sockaddr; //fzc: 上游服务器的地址
    socklen_t                        socklen;
    ngx_str_t                       *name; //fzc: 上游服务器的名称

    ngx_uint_t                       tries; //fzc: 表示连接上游服务器时, 连接失败后可以重试的次数, 即允许失败的最大

    ngx_event_get_peer_pt            get; //fzc: 获取连接的方法, 如果使用长连接构成的连接池, 那么必须要实现的get方法, 在ngx_event_connect_peer中调用
    ngx_event_free_peer_pt           free; //fzc: 释放连接的方法, 在ngx_http_upstream_finalize_request或ngx_http_upstream_next中调用
    void                            *data; //fzc: 传递给上述两个方法的参数, 具体参数的含义与实现两个参数的模块有关即负载均衡模块, 如见ngx_http_upstream_init_round_robin_peer

#if (NGX_SSL)
    ngx_event_set_peer_session_pt    set_session;
    ngx_event_save_peer_session_pt   save_session;
#endif

#if (NGX_THREADS)
    ngx_atomic_t                    *lock;
#endif

    ngx_addr_t                      *local; //fzc: 本机地址信息

    int                              rcvbuf; //fzc: 套接字的接收缓冲区大小

    ngx_log_t                       *log;

    unsigned                         cached:1; //fzc:? 标志位, 为1时表示上面的connection连接已经缓存

                                     /* ngx_connection_log_error_e */
    unsigned                         log_error:2; //fzc: 由于只有2bit, 因此无法表达NGX_ERROR_IGNORE_EINVAL, 只能表示四种错误日志等级
};


ngx_int_t ngx_event_connect_peer(ngx_peer_connection_t *pc);
ngx_int_t ngx_event_get_peer(ngx_peer_connection_t *pc, void *data);


#endif /* _NGX_EVENT_CONNECT_H_INCLUDED_ */
